home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / a_man / cat1 / html_package.z / html_package
Encoding:
Text File  |  2001-04-17  |  10.3 KB  |  265 lines

  1.  
  2.  
  3.  
  4. HHHHTTTTMMMMLLLL____PPPPAAAACCCCKKKKAAAAGGGGEEEE((((1111MMMM))))                                              HHHHTTTTMMMMLLLL____PPPPAAAACCCCKKKKAAAAGGGGEEEE((((1111MMMM))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      html_package - Create a HTML representation of an InSight book
  10.  
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      html_package [ -s bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh ] [ -o oooouuuuttttppppuuuutttt____ddddiiiirrrreeeeccccttttoooorrrryyyy ]
  14.                   [ -l cccchhhhuuuunnnnkkkkiiiinnnngggg____lllleeeevvvveeeellll ] [ -n ] [ -v ] bbbbooooooookkkk____nnnnaaaammmmeeee
  15.  
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      _h_t_m_l__p_a_c_k_a_g_e is part of iiiinnnnssssiiiigggghhhhtttt____ddddeeeevvvv, the IIIInnnnSSSSiiiigggghhhhtttt DDDDeeeevvvveeeellllooooppppeeeerrrr BBBBooooooookkkk BBBBuuuuiiiillllddddiiiinnnngggg
  19.      TTTToooooooollllssss.  It can be used to convert an InSight book (see _i_n_s_i_g_h_t(_1)) to
  20.      HTML.
  21.  
  22.      _h_t_m_l__p_a_c_k_a_g_e is a wrapper which encapsulates two sub-programs: ddddttttllll2222hhhhttttmmmmllll
  23.      and sssspppplllliiiitttthhhhttttmmmmllll. These programs may be run individually if more control
  24.      over the output is required. Their command line usage statements are
  25.      included at the end of this document.
  26.  
  27.      Additional customization can be done via the sssspppplllliiiitttthhhhttttmmmmllll configuration
  28.      file, sssspppplllliiiitttthhhhttttmmmmllll....ccccffffgggg. Examine the contents of that file for further
  29.      information.
  30.  
  31.      The HTML files that are produced can be read through a web server or
  32.      viewed from the file system using any standard web browser (such as
  33.      _n_e_t_s_c_a_p_e(_1)).
  34.  
  35.      By default, _h_t_m_l__p_a_c_k_a_g_e also creates a _t_a_r(_1) file containing the
  36.      newly-created HTML files (and images) for the purpose of easily moving
  37.      the files to alternate locations. This file will be created in the same
  38.      directory as specified by the oooouuuuttttppppuuuutttt____ddddiiiirrrreeeeccccttttoooorrrryyyy parameter (or the default
  39.      location).
  40.  
  41.  
  42. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  43.      Command line options are described below.
  44.  
  45.      bbbbooooooookkkk____nnnnaaaammmmeeee
  46.           bbbbooooooookkkk____nnnnaaaammmmeeee is a required option which mmmmuuuusssstttt appear as the last option
  47.           on the command line.  The bbbbooooooookkkk____nnnnaaaammmmeeee is the abbreviated short title
  48.           for the book.  See _i_n_s_i_g_h_t(1) for more details on bookshelves.
  49.  
  50.      -s   The -s bbbbooooooookkkksssshhhheeeellllffff____ppppaaaatttthhhh option tells _h_t_m_l__p_a_c_k_a_g_e which specific
  51.           bookshelf the bbbbooooooookkkk____nnnnaaaammmmeeee is on.  See _i_n_s_i_g_h_t(1) for more details on
  52.           bookshelves.
  53.  
  54.           By default, _h_t_m_l__p_a_c_k_a_g_e looks in the current working directory for
  55.           the existence of a bbbbooooooookkkkssss////<<<<bbbbooooooookkkk____nnnnaaaammmmeeee>>>> directory, which should contain
  56.           the IIIInnnnSSSSiiiigggghhhhtttt book to convert. If not found, an error is reported.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. HHHHTTTTMMMMLLLL____PPPPAAAACCCCKKKKAAAAGGGGEEEE((((1111MMMM))))                                              HHHHTTTTMMMMLLLL____PPPPAAAACCCCKKKKAAAAGGGGEEEE((((1111MMMM))))
  71.  
  72.  
  73.  
  74.      -o   The -o oooouuuuttttppppuuuutttt____ddddiiiirrrreeeeccccttttoooorrrryyyy option instructs _h_t_m_l__p_a_c_k_a_g_e where to place
  75.           the HTML files that are created. If the specified directory does not
  76.           exist, _h_t_m_l__p_a_c_k_a_g_e will attempt to create it.
  77.  
  78.           _h_t_m_l__p_a_c_k_a_g_e always appends a 'html' sub-directory specification
  79.           onto the oooouuuuttttppppuuuutttt____ddddiiiirrrreeeeccccttttoooorrrryyyy. The resultant files are placed in that
  80.           area.
  81.  
  82.           By default, _h_t_m_l__p_a_c_k_a_g_e will place the HTML files into a
  83.           ttttmmmmpppp____ggggeeeennnn////hhhhttttmmmmllll sub-directory, in the current working directory.
  84.  
  85.      -l   The -l cccchhhhuuuunnnnkkkkiiiinnnngggg____lllleeeevvvveeeellll  option instructs _h_t_m_l__p_a_c_k_a_g_e how to break up
  86.           or "chunk" the resultant HTML files. By default, the files are
  87.           broken up by the top-level entries reported in the book's table of
  88.           contents (_u_s_u_a_l_l_y these are chapters). This is a cccchhhhuuuunnnnkkkkiiiinnnngggg____lllleeeevvvveeeellll of
  89.           1111. Increasing this level will produce files that are (for example)
  90.           split by section level, or finer. In general, you should not have to
  91.           adjust this parameter.
  92.  
  93.      -n   The -n option instructs _h_t_m_l__p_a_c_k_a_g_e to nnnnooootttt produce the _t_a_r(_1) file
  94.           containing the newly-created HTML files (and images).
  95.  
  96.      -v   The -v option instructs _h_t_m_l__p_a_c_k_a_g_e to produce more detailed
  97.           output. By default, it will report only a few status messages (and
  98.           any critical errors).
  99.  
  100. EEEEXXXXAAAAMMMMPPPPLLLLEEEESSSS
  101.       /usr/lib/Insight/dweb/dtl2html/html_package -s /usr/share/Insight/library/SGI_bookshelves/SGI_EndUser ImgTools_UG
  102.  
  103.       /usr/lib/Insight/dweb/dtl2html/html_package -s /usr/share/Insight/library/SGI_bookshelves/SGI_Developer -v -o /usr/tmp/my_html_book CLanguageRef
  104.  
  105. UUUUSSSSAAAAGGGGEEEE SSSSTTTTAAAATTTTEEEEMMMMEEEENNNNTTTTSSSS
  106.      The ddddttttllll2222hhhhttttmmmmllll usage statement:
  107.  
  108.      Usage : dtl2html  -s bookshelf -b short_book_name
  109.                      [ -d data_dir ]
  110.                      [ -n ]
  111.                      [ -o output_dir ]
  112.                      [ -t stylesheet ]
  113.                      [ -v ]
  114.                      [ -w dweb_dir ]
  115.      where :
  116.  
  117.        -b   REQUIRED- short name for the {b}ook; example: "Desktop_UG"
  118.  
  119.        -s   REQUIRED- fullpath specification of the book{s}helf; example:
  120.             "/usr/share/Insight/library/SGI_bookshelves/SGI_EndUser"
  121.  
  122.        -d   {d}ata directory; default is /usr/lib/Insight/data
  123.  
  124.        -n   indicates to {n}ot fetch figures/images.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. HHHHTTTTMMMMLLLL____PPPPAAAACCCCKKKKAAAAGGGGEEEE((((1111MMMM))))                                              HHHHTTTTMMMMLLLL____PPPPAAAACCCCKKKKAAAAGGGGEEEE((((1111MMMM))))
  137.  
  138.  
  139.  
  140.        -o   location of directory where {o}utput will be placed.
  141.             defaults to "<current_directory>/html"
  142.  
  143.        -t   indicates to use a specific s{t}ylesheet;
  144.             this MUST reside in book's style dir; example: "fullnewstyle.v"
  145.  
  146.        -v   operate in {v}erbose mode.
  147.  
  148.        -w   Dyna{w}eb directory; default is /usr/lib/Insight/dweb
  149.  
  150.      The sssspppplllliiiitttthhhhttttmmmmllll usage statement:
  151.  
  152.      usage: splithtml {-c cfg_file} {-l lvl_id} {-f fname_spec}
  153.                                 {-o output_dir} {-v} {-noclean} in_html_file
  154.  
  155.      -c cfg_file    : is the configuration file to use. See the default file:
  156.                       /usr/lib/Insight/dweb/dtl2html/splithtml.cfg for info.
  157.  
  158.      -l lvl_id      : is the level to break/chunk on (based on TOC)
  159.                       default used is "1"
  160.  
  161.      -f fname_spec  : is the filename convention to use, must have a
  162.                       "%d" within the string, as in "sgi%05d.html"
  163.                       which serves as the default is not provided.
  164.  
  165.      -o output_dir  : location to write the output files to, default is the
  166.                       same directory the in_html_file is from.
  167.  
  168.      -v             : operate in verbose mode.
  169.  
  170.      -noclean       : do not remove the old fullbook.htm{l} file and it's
  171.                       associated TOC data files. They are removed by default.
  172.  
  173.      in_html_file   : REQUIRED. Name of the fullbook.htm{l} file to
  174.                       process. Also denotes location of the TOC data
  175.                       files. Files created will be written to the same
  176.                       area, unless otherwise designated
  177.  
  178. FFFFIIIILLLLEEEESSSS
  179.      /usr/lib/Insight/dweb/dtl2html/html_package
  180.      /usr/lib/Insight/dweb/dtl2html/dtl2html
  181.      /usr/lib/Insight/dweb/dtl2html/splithtml
  182.      /usr/lib/Insight/dweb/dtl2html/splithtml.cfg
  183.  
  184. CCCCAAAAVVVVEEEEAAAATTTTSSSS
  185.      This process can be quite slow.
  186.  
  187. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  188.      _i_n_s_i_g_h_t(_1), _d_y_n_a_w_e_b(_1_m)
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. HHHHTTTTMMMMLLLL____PPPPAAAACCCCKKKKAAAAGGGGEEEE((((1111MMMM))))                                              HHHHTTTTMMMMLLLL____PPPPAAAACCCCKKKKAAAAGGGGEEEE((((1111MMMM))))
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.                                                                         PPPPaaaaggggeeee 4444
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.